High level description

This contributions aims to provide a local storage solution for citations relations using MVStore. Please see #11189 for more information.

Fixes #11189

Implementation details

No new dependency added.

Caching strategy

The caching logic of the citations/references is now fully handled by h2.mvstore.MVStore. The store is responsible of the in memory caching and the offline storage logic.

This aims to avoid JabRef to access the Internet if the user already searched for citations/references related to one of its bib entry.

The cache/local store is common to all the libraries managed by the JabRef instance.

Search caching high level logic

1. Check if the fetch is possible: if the cache does not contain anything or if the local storage TTL ran out
2. If the fetch is possible: fetch and insert into cache (in memory and locally)
3. Read from cache (if the in-memory cache is empty then load from local storage and update in-memory cache)

Serialization

MVStoreDAO uses the canonical representation to serialize a BibEntry and the BibtexParser to deserialize it.

Configuration

• the search service is a singleton injected in each new Citations Relations tab using the JabRef IoC provider
• the store path is configured to target the citations folder under JabRef's app directory

Setting translation

The the local storage TTL setting message has been traduced in:

• DE
• FR
• EN
• PL
• IT
• BR

Refactoring

This contributions simplifies the citations/references fetching and caching logic by introducing two layers:

• service
• repository

This should help to make this feature more extendable without modifying orchestration logic following open/close principle.

Screen shots

Mandatory checks

• I own the copyright of the code submitted and I license it under the MIT license
• Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
• Tests created for changes (if applicable)
• Manually tested changed features in running JabRef (always required)
• Screenshots added in PR description (for UI changes)
• Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
• Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.